[#1101] Fix JavaDoc Generation Errors/Warnings#1105
Conversation
…slation to EKCert details page
…e in the build.gradle that prevents the javaDOc task from analyzing the geenrated protobuf file.
… that should be in the same package, deleted unused files (confirmed by running the ACA and checking using the control + f combo), and create new packages for files that should be in their own package. almost done with attestationca module.
…e correct package.
…vadoc warnings as possible.
ThatSilentCoder
added
the
documentation
…arnings # Conflicts: # HIRS_AttestationCAPortal/src/test/java/hirs/attestationca/portal/page/controllers/TrustChainManagementPageControllerTest.java # HIRS_Utils/src/main/java/hirs/utils/rim/unsignedRim/GenericRim.java # HIRS_Utils/src/main/java/hirs/utils/rim/unsignedRim/cbor/ietfCoswid/CoswidBuilder.java # build.gradle
…ontinue addressing more warnings from the utils module.
…ited warning lines.
iadgovuser59
left a comment
iadgovuser59
left a comment
There was a problem hiding this comment.
Sorry for the delay on this.
I would say that my hesitation here might be the somewhat large number of refactoring/cleanup changes and lines of code (>3000 changed/removed) vs. Javadoc-specific changes to remove errors/warnings by themselves. I'd say it might be a good idea to split the refactoring/cleanup from the Javadoc-specific resolutions perhaps for a more compact PR size.
I have followed your advice and moved the refactor/cleanup changes to PR #1151. Once that PR has been approved and merged into main, the num of files changed in this PR should drastically go down. |
ThatSilentCoder
dismissed
iadgovuser59’s stale review
Addressed review comments made by user and changes have been approved by another party. This error is blocking me from merging changes into main.
3 participants
Description
Running
./gradlew javadocon the main branch currently generates numerous errors across several modules. The objective of this task is to resolve these errors and warnings so that the Gradle command successfully generates JavaDocs for the HIRS application.Test Instructions:
Verify Gradle Build:
Run
./gradlew javadocto ensure that no errors are displayed during the generation process. Note that warnings will appear across most modules—each module may have around 100+ warnings. These warnings can generally be ignored, as they do not prevent Gradle from successfully generating the JavaDocs.Examine Generated JavaDocs:
After running the command, review the generated JavaDocs to ensure that they are complete and properly formatted. Check that all relevant classes, methods, and fields are documented and that there are no missing or incomplete descriptions.
HIRS_AttestationCA Complete JavaDocs Location:
HIRS_AttestationCA Portal Complete JavaDocs Location:
HIRS_Utils Portal Complete JavaDocs Location:
Check for Inconsistent Formatting:
Look for any inconsistencies in the JavaDoc formatting, such as missing tags (e.g.,
@param,@return,@throws), or incorrect HTML markup. Ensure that the overall style adheres to the project’s JavaDoc standards.Issues This PR Addresses:
Closes #1101